Account Information API
Technical Notes
Endpoints
Note: Currrently this API is only used for Co-op Optis Clients. If you are looking for Card Account information for Co-op Connex Clients please see the Plastics Management API - connex/card.get endpoint
/omaha/cardholder-account-presentation.get
refered to as the GetCAP
The following reference tables are for this endpoint:
- Refer to the Automatic Payments Codes in the Resources below for the field atmt_Pymt_Cd .
- Refer to the Plastics Mail Codes in the Resources below in the Plastics Management API for the field mail_Cd.
- These Custom Object tables define the object model regarding:
- For the return value CAP, refer to the CAP Definitions table below.
- For the return value Customer, refer to the Customer Definitions table below.
/omaha/dda.get
Used for online debit processors only on the Optis platform - returns back associated debit information.
/omaha/debit-balance.get
Used for online debit processors only on the Optis platform - returns back associated debit funds amount information
/omaha/datalink.get
The DataLink() array will be an array of Custom Objects defined in the table below. Each object's data type is a String. Each field in the Datalink view maps to one object in the Datalink() array. The name of the field will be passed through in the ‘ELMN_ID’ field and the data will be passed through in the ‘ELMN_TX’ field.
Property |
ACCT_ID |
ACCT_NR |
AGNT_ID |
AGNT_NR |
CHD_ACCT_NR |
CLNT_ID |
CLNT_NR |
CNVR_ENTR_ID |
ELMN_CLER_TEXT_IN |
ELMN_DFLT_TX |
ELMN_ID |
ELMN_INPT_CD |
ELMN_NM |
ELMN_TX |
ELMN_UPDT_IN |
ELMN_VIEW_IN |
ENTR_ID |
PRIN_ID |
PRIN_NR |
SYS_ID |
SYS_NR |
/omaha/payment-history.get
Provide access to information about cardholder account payment history across multiple payment cycles.
/omaha/cardholder.get
Provide information around authorization override strategy, fraud strategy as well as autopay custom amount information
Resources
Automic Payment Codes
This Automatic Payments Codes Table is a reference for the field atmt_Pymt_Cd for /omaha/cardholder-account-presentation.get in the Account Information API.
System Calculated Monthly Amount Options
Code | Payment Source | Calculation Option Title |
---|---|---|
E F |
Checking account Savings account |
Full Balance Amount |
3* | Checking account OR Savings account* |
Full Statement Balance Including Disputes* |
4 7* |
Checking account Savings account* |
Full Statement Balance* |
2 6 |
Checking account Savings account |
Full Statement Balance or Unpaid Billed Minimum Payment Due |
8* | Checking account OR Savings account |
Full Statement Balance Including Disputes Minus Cycle-to-Date Payments* |
C D |
Checking account Savings account |
Last Statement Times Balance Calculation Rate |
G I |
Checking account Savings account |
Minimum Payment Due Minus Cycle-to-date Payments, Returns, and Special Credits |
A B |
Checking account Savings account |
Minimum Payment Due Minus Delinquent Amount |
P Q |
Checking account Savings account |
Payment Fixed Amount Minus Cycle-to-date Payments |
1 5 |
Checking account Savings account |
Unpaid Billed Minimum Payment Due |
T U |
Checking account Savings account |
Unpaid Billed Minimum Payment Due Plus Overlimit Amount |
Customer-Designated Amount Options
Code | Payment Source | Calculation Option Title |
---|---|---|
J K |
Checking account Savings account |
Customer-Designated Amount |
Y Z |
Checking account Savings account |
Customer-Designated Amount and Unpaid Billed Minimum Payment Due Plus Overlimit Amount |
V W |
Checking account Savings account |
Customer-Designated Amount Minus Cycle-to-Date Payments |
L M |
Checking account Savings account |
Customer-Designated Amount Minus Cycle-to-date Payments, Returns, and Special Credits |
H X |
Checking account Savings account |
Customer-Designated Amount Plus Unpaid Billed Minimum Payment Due |
9* | Checking account OR Savings account |
Customer-Designated Amount or Unpaid Billed Minimum Payment Due |
R S |
Checking account Savings account |
Customer-Designated Amount or Unpaid Billed Minimum Payment Due Plus Overlimit Amount |
Note
*This option uses the customer checking account specified on the Cardholder Master File as the Demand Deposit Account (DDA) for Automatic Payments. If no checking account is specified, the System uses the customer savings account specified on the Cardholder Master File. If a checking account number and a savings account number are not specified on the file, the automatic payment withdrawal will not occur.
CAP Definitions
For the endpoint - /omaha/cardholder-account-presentation.get - the following table defines the object model regarding the return value of CAP.
Custom Object Definitions for CAP
Property   | Description   |
---|---|
   INCN_PLAN_END_DT       |
Incentive Planned End Date Date scheduled for incentive-pricing to end. Format: YYMMDDÂ Â Â |
   ADDT_XREF_TWO_ID   |
Additional Cross-reference   Number 2 Identifier Identifier of another account associated with the principal cardholder. 16 character max   |
   RESS_EXPR_DT   |
Reissue Expiration Date Expiration date of the old   plastic for an account in the reissue process. Format: MMYY   |
   CRRN_MPD_AM   |
Current Minimum Payment Due   Amount Minimum payment due to make   the account current. Format: 9999999999999999   |
   MISC_FIVE_ID       |
Miscellaneous Field 5 Identifier Client-defined 8 character max   |
   MAIL_UPDT_CD       |
Mail Update Code Code determining how you change the mail code flag. Valid codes: 0 = Update the mail code via the NM*65, Mail Code/Mail Code Update Flag transaction, or through force embossing 60 days prior to reissue. 1 = Update the mail code via the NM*65, Mail Code/Mail Code Update Flag transaction. |
   CASH_ADVN_OTST_BAL_AM       |
Cash Advance Outstanding Balance Amount Total amount of cash advances taken and not yet paid. Format: 999999999999999Â Â Â |
   DDA_ID       |
Demand Deposit Account Identifier Identifier of the demand deposit account. 17 character max   |
   PRVS_EXPR_DT       |
Adjustment Expiration Date Previous expiration date if a NM*14, Expiration Date transaction, was entered to change expiration date. Format: MMYYÂ Â Â |
   DSPT_TOTL_AM       |
Total Dispute Amount Total amount of all items currently in dispute. Format: 9999999999999999.99Â Â Â |
   MISC_SIX_ID   |
Miscellaneous Field 6 Identifier Client-defined 12 character max   |
   OPEN_DAY_DT   |
Open Day Date Day of the month the account was added to the Cardholder Master File. The full account open date may be obtained by selecting both the OPEN_DT and OPEN_DAY_DT fields. Format: DD |
   DSPT_TRAN_CT   |
Times in Dispute Count Count of times disputed transactions posted to this account in the last two years plus year to date. Format: 999 |
   SVNG_ACCT_ID    |
Savings Account Identifier Identifier of the customer savings account. 17 character max |
   LAST_PYMT_DT    |
Last Payment Date Date the most recent payment posted to the account. Format: YYMMDD |
   DLNQ_AM    |
Delinquent Amount Dollar amount the account is at least one-cycle delinquent. If the account is not delinquent, this amount reflects the credit limit for the account. Format: 9999999999999999 |
   MISC_SEVN_ID    |
Miscellaneous Field 7 Identifier Client-defined 10 character max |
   NEXT_STMT_HOLD_CD    | Statement Hold Code Code representing whether a hard copy statement is produced and where the hard copy statement is sent. Valid codes: * C = Sort hard copy statements according to customer account identifier and mail to you. * D = System-generated code that represents default strategy ZBFD has been assigned to customer. * N = Send hard copy statement to customer. * R = Returned mail, do not print a hard copy statement. If this field is set to R, the System generates the NM*165, Hold Correspondence transaction, to set the hold correspondence flag to 1. Setting the hold correspondence flag to 1 prohibits the System from printing delinquency notification statements, overlimit courtesy statements, and messages. In addition, it may prohibit the System from printing automatically generated letters, including automatic credit line changes, automatic external status code changes, and automatic charge offs. The System automatically changes R to N once address information is updated. If this field is set to R, it can only change to N. The System rejects any attempts to change this field to any other value and generates the following message: CARDHOLDER STMT HOLD CODE IS R. * S = Send hard copy statement to System Fraud Management Services. If this field is set to S and you use the Adaptive Control System, automated letters and letter data generated out of the Adaptive Control System (ACS) will not be produced. * V – Enlarge statement contents to fit on 11x14 paper and send to customer. * W – Do not print a hard copy statement. Instead, produce the statement only for CIS (Customer Inquiry * Y – Send hard copy statement to you. If this field is set to Y and you use the Adaptive Control System, automated letters and letter data generated out of the Adaptive Control System will not be produced. * 1-9 = Send hard copy statement to you for this number of billing cycles. Each time a statement is sent, the System subtracts 1 from the number in this field. When the number reaches zero, the System resets the Held Statement Destination Code to N, the Held Statement Sort Distribution Code to zeroes, and sends the next statement to the customer. If this field is set to 1-9 and you use the Adaptive Control System, automated letters and letter data generated out of the Adaptive Control System will not be produced. * blank = Send hard copy statement to customer. |
   DLTY_CD    | Duality Code Code representing whether the account is dual. Valid codes: * 0 – Account is not dual * 1 – Dual account, issue plastics only on the primary account * 2 – Dual account, issue plastics only on the secondary account * 3 – Dual account, issue plastics on the primary and secondary accounts |
   AGNT_BANK_NM    |
Agent Bank Name Agent name used on the agent’s reports and in the return address on mailers. 34 characters max |
   IRS_HOME_EQTY_RPRT_CD    |
IRS Home Equity Report Code Code representing whether this is a home equity account for IRS home equity reporting. Valid codes: * 0 – Not a home equity account * 1 – Home equity account * 2 – Home equity account established after 1987 for a purpose other than the purchase of a personal residence |
   YTD_BLLD_INTR_AM    | Year-to-date Interest Amount Amount of interest billed year to date. Format: 9999999999999999.99 |
   MISC_EGHT_ID    | Miscellaneous Field 8 Client-defined 10 characters max |
   USER_FLAG_ONE_TO_FOUR_ID    | Flag 1-4 Identifier Issuer-defined special flags. Flag 1* used for Card Activation/Verification. Valid Codes for Flag 1: * blank = Activation status not defined * N = Activation added for a New Account * R = Activation added for a Reissued Account * V = Activation complete; Cardholder verified. *Flags 2-4 are not used. |
   AUTH_TOTL_AM    | Authorization Total Amount Whole-dollar amount of authorizations for which matching transactions have not cleared. Format: 999999999999999 |
   ATMT_PYMT_CD    | Automatic Payment Code Code representing whether the customer account is set up for recurring Automatic Payments and, if so, whether to debit the customer’s checking or savings account for the Automatic Payment amount. This amount can be: * The minimum payment due * The last statement’s balance * The current balance * A designated amount * A fixed amount * The Automatic Payment ceiling amount. Set the Automatic Payments Option parameter in the Automatic Payments section (AO CH AP) of the Product Control File to zero, 2, or 3 to use the Automatic Payments feature. Click the link in the valid code list for more information. See Automatic Payments Codes wiki in the Plastics Management API. |
   EQTY_ACCT_MTRT_DT    | Equity Account Maturity Date Date the home equity account is due for renewal. Format: YYYYMMDD    |
   FIXD_PYMT_AM    | Fix Payment Amount Dollar-and-cent amount of the fixed payment. Format: 9999999999999999.99    |
   MISC_NINE_ID    | Miscellaneous Field 9 Identifier Client-defined 10 characters max |
   PLST_TYPE_PLST_CD    | Plastic Type Code Type of plastic to emboss. Valid codes: * 0 = Do not emboss plastics for the principal cardholder on this account. * 1 = Use the parameters in the Plastic Products strategy for plastic type 1 to emboss plastics on this account. * 2 = Use the parameters in the Plastic Products strategy for plastic type 2 to emboss plastics on this account. * 3 = Use the parameters in the Plastic Products strategy for plastic type 3 to emboss plastics on this account. * 4 = Use the parameters in the Plastic Products strategy for plastic type 4 to emboss plastics on this account. * 5 = Use the parameters in the Plastic Products strategy for plastic type 5 to emboss plastics on this account. * 6 = Do not emboss plastics or create embossing records for this account. This value is for special use when you set the Embossing Services Option parameter in the Embossing Processing section (AO AC EM) of the Product Control File to N. * 7 = Do not emboss plastics or create embossing records for this account. This value is for special use when you set the Embossing Services Option parameter in the Embossing Processing section of the Product Control File to N. |
   YTD_BLLD_MDSE_CHRG_AM    | Year-to-date Purchase Amount Amount of merchandise item charges billed to the account during the year to date. Format: 9999999999999999.99 |
   RNWL_CD    | Renewal Code Code determining how often the System reissues the plastics Valid codes: * 0 = Do not reissue * 1 = Reissue in six months * 2 = Reissue in 12 months * 3 = Reissue in 18 months * 4 = Reissue in 24 months * 5 = Reissue in 30 months * 6 = Reissue in 36 months * 7 = Reissue in 48 months * 8 = Reissue in 60 months. * 9 = Plastic is non-expiring The expiration date for a nonexpiring plastic displays as 99-99 on the cardholder account record. The expiration date is encoded as 4912 on the magnetic stripe if a plastic is produced. |
   LAST_STTS_CODE_CHNG_DT       |
Last Status Code Change Date Date of last status change. This field contains 000000 if the account has never been active. Format: YYMMDD |
   DAYS_DLNQ_CT       |
Days Delinquent Count Count of days an account has been delinquent. Format: 999 |
   MISC_TEN_ID       |
Miscellaneous Field 10 Identifier Client-defined 10 characters max |
   OTST_AUTH_BAL_AM       |
Outstanding Authorization Balance Amount Reserved for restricted use. Format: 9999999999999999.99 |
   PRVS_YEAR_MDSE_PRCH_AM       |
Previous Year Purchases Amount Amount of merchandise purchase history for the year to date and previous year. Format: 9999999999999999.99 |
   RESS_CNTR_CD    | Reissue Control Code Code controlling reissue processing. The System automatically sets this field at month end based on your reissue criteria. The meaning of the values appearing in this field depends on whether you use a 60-day or 90-day reissue cycle. Valid codes for 60-day reissue cycle: * 0 = Account not in reissue * 1 = Account 60 days from expiration and is to be reissued * 3 = Account 30 days from expiration and is to be reissued * 4 = Account 60 days from expiration and is not to be reissued * 6 = Account 30 days from expiration and is not to be reissued Valid codes for 90-day reissue cycle: * 0 = Account not in reissue * 1 = Account 90 days from expiration and is to be reissued * 2 = Account 60 days from expiration and is to be reissued * 3 = Account 30 days from expiration and is to be reissued * 4 = Account 90 days from expiration and is not to be reissued * 5 = Account 60 days from expiration and is not to be reissued * 6 = Account 30 days from expiration and is not to be reissued. This field is also used for identification codes if the Customer Use Flag ID parameter in the Card Activation section (RF AM CA) of the Product Control File is set to provide verification of plastic receipt and/or transfer the first authorization attempt for new or reissued plastics to System Fraud Management Services. Valid codes for Issued Plastics: * 7 = Positive cardholder identification and/or verification of plastic receipt has not yet been established for this new plastic or plastic issued for a reason other than reissue. * 8 = Positive cardholder identification and/or verification of plastic receipt has not yet been established for this reissued plastic. * 9 = Cardholder identification was established today. Management Services at the first authorization of this plastic or you chose not to have System Fraud Management Services verify cardholder identification. Codes 7 and 8 remain in this field until positive identification is established. When positive identification is established or the choice is for System Fraud Management Services to verify cardholder identification, the code will immediately change to 9. Code 9 then moves to the USER FLAG field during nightly update. The particular USER FLAG position in which the 9 appears depends on the valid code chosen in the Customer Use Flag ID parameter. The CONTROL field returns to displaying the code controlling reissue processing. |
   LAST_NMN_DT    | Last Non-Monetary Date Date of the last non-monetary transaction that was initiated. Format: YYMMDD |
   TOTL_DLNQ_ONE_CYCL_CT    | Total Number of Times One-cycle Delinquent Count Number of times the account has been one cycle delinquent in the last two years plus year to date. Format: 999 |
   CRRN_BAL_AM    | Balance Amount Format: 9999999999999.99    |
   OTST_PLST_CT    | Presentation Instrument Outstanding Count Count of outstanding plastics on a cardholder account. Format: 999 |
   PRVS_YEAR_PAID_INTR_AM    | Previous Year Paid Interest Amount Amount of credit interest paid for the previous year. Format: 999999999999.99 |
   CRDT_LIFE_STAT_CD    | Credit Life Status Code Code determining if a credit insurance claim is being processed. Valid codes: * A – Credit insurance claim has been accepted. * N – No credit insurance claim is being processed. * P – Credit insurance claim is pending. |
   LAST_PLST_DT    | Last Plastic Date Date System issued the most recent plastic to a cardholder. Format: YYMMDD |
   TOTL_DLNQ_TWO_CYCL_CT    | Total Number of Times Two-cycles Delinquent Count Number of times the account has been two cycles delinquent in the last two years plus year to date. Format: 999 |
   CRBR_RPRT_CD    | Credit Bureau Reporting Code Code representing either a request for an action related to credit reporting or the consumer’s liability for the account. * T = Terminated * X = Deceased * Z = Do not report * 1 = Individual. This code identifies a cardholder who has contractual responsibility for this account and is primarily responsible for payment. * 2 = Joint contractual liability. This code identifies a cardholder and joint borrower who are both contractually liable. * 3 = Authorized user. This code identifies a consumer who can use this account without joint responsibility for payment. * 5 = Co-maker. This code identifies cosigners without a spouse relationship. * 7 = Maker. This code identifies a cardholder who is liable for the account, but the co-maker is liable if the maker defaults. |
   SYS_ID    | System Identifier System-assigned identifier of the level used to group Principal Identifiers together for processing and reporting. 4 digits |
   LABL_TYPE_CD    | Code representing the presentation instrument’s label type Valid codes: * 0 = Test system * 1 = MasterCard * 2 = Airline Private Label * 3 = American Express * 4 = Visa * 5 = Diner’s Club * 9 = Private Label |
   CRDT_LIFE_CD    | Credit Life Code Code representing the credit insurance indicator. Valid codes: * 0 = Do not charge credit insurance premium * 1-9 = Charge the credit insurance premium based on the plan parameter settings in the Credit Life section (CP IO CL) of the Product Control File. |
   LAST_ADDR_CHNG_DT    | Last Address Change Date Date you last changed the cardholder’s address. Format: YYMMDD |
   TOTL_DLNQ_THRE_CYCL_CT    | Total Number of Times Three-cycles Delinquent Count Number of times the account has been three or more cycles delinquent in the last two years plus year to date. Format: 999 |
   BLLN_CYCL_CD    | Billing Cycle Code Code determining sub-account verification for this company to ensure that all sub-accounts have the correct billing cycle code. 2 characters |
   PRIN_ID    | Principal Identifier Client-defined identifier of the level within a System Identifier that is used to group Agent Identifiers together for processing and reporting. 4 characters |
   FRAD_ASSG_STGY_ID    | Fraud Assigned Strategy Identifier Client-defined strategy identifier assigned for fraud authorization decision processing Code 98 is reserved for special processing; do not use. 2 digits |
   EXTR_STTS_CD    | External Status Code Code determining the external status for the account. The System assigns status Z when a charge-off adjustment is made. Valid codes: * A = Authorization prohibited * B = Bankrupt * C = Closed * E = Revoked * F = Frozen * I = Interest accrual prohibited * L = Lost * U = Stolen * Z = Charged off * blank = Normal |
   LAST_CASH_DT    | Last Cash Advance Date Reserved for future use Format: YYMMDD |
   TOTL_NMBR_PLST_CT    | Total Number of Plastics Issued Count Number of plastics issued on this account. 3 digits |
   HIGH_BAL_AM    | High Balance Amount Amount of the highest dollar balance billed in the last two years plus year to date. Format: 9999999999999999 |
   AGNT_ID    | Agent Identifier Client-defined identifier of the level within a Principal Identifier that is used to group accounts together for processing and reporting. 4 digits |
   FRAD_SSPN_STGY_ID    | Fraud Suspend Strategy ID Code determining whether you want to restrict this account from fraud authorization decision processing (via the Falcon™ Strategy System or the DefenseEdgeSM service of Rules Management) or send this account to a new strategy until the date specified in the FR_SUSP_STRAT_DATE field. A value of 00 indicates this account does not allow fraud authorization decision processing. 2 digits |
   EXTR_STTS_RESN_CD    | External Status Reason Code Issuer-defined code representing the reason for the external status For an external status of C (closed), the following status reason codes indicate that the System closed the account for the listed reason. Status reason codes: * 85 - Closed due to your Adaptive Control over-limit strategy * 86 - Closed due to your Adaptive Control delinquent strategy * 87 - Closed due to your Adaptive Control reissue strategy * 90 - Closed due to your setting in the delinquency action code parameters in the Delinquency Processing section (DO DC DP) of the Product Control File * 91 - An old account closed after an account transfer due to your settings in the Automatic Close Days After Transfer and Status Reason Code Overlay Switch parameters in the Account Maintenance section (AO CH AM) of the Product Control File * 92 - Closed in the reissue process due to your setting in the delinquent and over-limit parameters in the Eligibility section (RE CR EL) of the Product Control File * 93 - Closed in the reissue process due to your settings in the Reissue Terms parameter in the Eligibility section (RE CR EL) of the Product Control File and the Ratification Level parameter in the Debit Ratification section (AO AC DR) of the Product Control File * 94 - Closed in the reissue process due to your settings in the Include/exclude States and Reissue States parameters in the Eligibility section (RE CR EL) of the Product Control File * 95 - Closed in the reissue process due to an external status other than A or blank * 96 - Closed in the reissue process due to your setting in the Inactive Option parameter in the Reissue Options section (RE OP RO) of the Product Control File. * 97 - Closed by consumer For an external status of Z (charged off), the following status reason codes indicate that t he charge-off is for the listed reason. Status reason codes: * 68 - Legally paid in full for less than the full balance * 88 - Fraud * 89 - Bankrupt * 99 - Abandoned |
   LAST_PIN_MALR_DT    | Last PIN Mailer Date Date the most recent PIN mailer was sent. Format: YYMMDD |
   CYCL_OVRL_CT    | Cycled Over limit Count Count of times the account statements were in an over-limit status in the last two years plus year to date. 2 digits |
   CRDT_LIMT_AM    | Credit Limit Amount Maximum whole-dollar amount of credit extended to the account. Format: 9999999999999999 |
   CRDT_SCOR_ID    | Credit Score Identifier Identifier based on the evaluation of an applicant’s credit history. 3 digits |
   Customers()    |    Array of Customer Objects    |
   FRAD_STGY_CHNG_DT    | Fraud Strategy Change Date Date the account was most recently assigned a fraud strategy by the Client Allocation Table. Format: YYMMDD |
   INRL_STTS_CD    | Internal Status Code System-assigned status code determining specific account processing. Valid codes: * D = Delinquent * O = Over-limit * X = Delinquent and over-limit * blank = Normal or credit balance |
   STMT_MPD_DT    | Payment Due Date Date when the minimum payment is due for this billing cycle. Format: MMDD |
   REAG_CT    | Re-age Count Number of times delinquency has been manually or automatically removed and the current status restored in the last two years plus year to date. 2 digits |
   LAST_CRDT_LINE_CHNG_DT    | Last Credit Line Change Date Format: MMYY |
   FRAD_SCOR_ID    | Fraud Score Identifier Score representing the possible fraudulent risk of an account, where 000 has the least potential for fraud and 999 has the highest potential for fraud. 3 digits |
   ACCT_ID    | Account Identifier Up to 19 digits |
   FRAD_SSPN_STGY_DT    | Fraud Suspend Strategy Date. Date indicating when you want the System to resume Falcon Strategy System / DefenseEdge service of Rules Management processing on account. Format: YYMMDD |
   INCN_ANNL_CASH_RT    | Incentive Annual Cash Rate Annual interest rate charged on incentive pricing cash advance principal. 5 digits |
   PYMT_HSTR_CD    | Payment History Code Account’s activity history for the past 12 months. The 12 status flags rotate when the account cycles so that the left-most flag indicates the account’s status during the last cycle and the right-most flag indicates the account’s status during the current cycle one year ago. The System automatically changes the first flag when the account’s status changes due to an account transfer or due to the posting of an across-cycle reversal, adjustment, or interest charge-off. Only the first flag on the left (last cycle) changes by these postings. At cycle time, the System assesses the account’s status and places an appropriate status flag in the first position. Each of the other flags shift one position to the right, with the right-most flag moving to the first position of the PAY_HIST_13_24 field. Flag values: * Z = Statement not generated because of zero balance and no activity * 0-7 = No postings during the cycle – the number indicates the number of cycles delinquent A-H –Debit postings only during the cycle Valid codes: * A = Account not delinquent * B = Account 1 cycle delinquent * C – Account 2 cycles delinquent * D = Account 3 cycles delinquent * E = Account 4 cycles delinquent * F = Account 5 cycles delinquent * G = Account 6 cycles delinquent * H = Account 7 cycles delinquent |
   PYMT_HSTR_CD (continued)    | I-P = Credit postings only during the cycle Valid codes: * I = Account not delinquent * J = Account 1 cycle delinquent * K = Account 2 cycles delinquent * L = Account 3 cycles delinquent * M = Account 4 cycles delinquent * N = Account 5 cycles delinquent * O = Account 6 Cycles delinquent * P = Account 7 cycles delinquent Q-X = Both debit and credit postings during the cycle Valid codes: * Q = Account not delinquent * R = Account 1 cycle delinquent * S = Account 2 cycles delinquent * T = Account 3 cycles delinquent * U = Account 4 cycles delinquent * V = Account 5 cycles delinquent * W = Account 6 cycles delinquent * X = Account 7 cycles delinquent * % = Credit balance with no activity * # = Credit balance with debit and credit activity * + = Credit balance with debit activity only * - = Credit balance with credit activity only Debit activity means sale and cash advance postings. Credit activity means payment and return postings. |
   SPCL_FLGS_FIVE_TO_EGHT_ID    | Special Flags 5-8 Identifier Issuer-defined flags identifying special conditions in the cardholder record. Assign codes to special flags 5 through 8 using the NM*17, Special Flags transactions. The codes assigned via the NM*17 transaction appear in this field with the following exception: the first position of the special flags field displays the code assigned to special flag 5. However, if the Inactive Option parameter in the Reissue Options section (RE OP RO) of the Product Control File is set to a value other a zero, the first position of this field displays a System-assigned code that you cannot change. 4 characters |
   CASH_AVLB_CRDT_LIMT_AM    | Cash Available Credit Limit Amount of the maximum whole-dollar credit limit for cash advances. Format: 9999999999999999 |
   MISC_ONE_ID    | Miscellaneous Field 1 Identifier Client-defined 4 characters |
   CALC_NORM_MRCH_ANNL_RT    | Current Annual Merchandise Rate Format: 999.999 |
   INCN_ANNL_MDSE_RT    | Incentive Annual Merchandise Rate Annual interest rate charged on incentive pricing merchandise principal. Format: 99999 |
   TRNS_RTNG_ID    | Transit Routing Identifier Financial institution identification number assigned by the Federal Reserve System. 9 digits |
   STMT_DT    | Statement Date Date the account last cycled. This field will only return information when you use one of the following fields in the WHERE clause for the STATEMENT_FORM view. * CARDHDLR * ENTR_ID Format: YYYYMMDD |
   AVLB_CRDT_AM    | Available Credit Amount Amount of the account’s unused credit. A minus sign preceding the amount indicates that the account is over its credit limit. Format: 9999999999999999 |
   MISC_TWO_ID    | Miscellaneous Field 2 Identifier Client-defined 5 characters |
   OPEN_DT    | Open Date Month and year the account was added to the Cardholder Master File. Format: MMYY |
   INCN_STGY_DT    | Incentive Start Date Date the incentive pricing period is scheduled to begin. Format: YYMMDD |
   XREF_ID    | Cross-reference Identifier Identifier of another account associated with the principal cardholder. 16 digits |
   LAST_STMT_DT    | Last Statement Date Date of the most recent statement. Format: YYMMDD |
   LAST_STMT_BAL_AM    | Last Statement Balance Amount Dollar-and-cent amount of the most recent statement balance. Format: 99999999999999999.99 |
   MISC_THRE_ID    | Miscellaneous Field 3 Identifier Client-defined 7 characters |
   PI_BULK_ID    | Presentation Instrument Bulk Mail Identifier Client-defined identifier of the address to which plastics are to be shipped in Bulk. This field is reserved for CIU clients whose plastics are embossed by Central Issuance and who use the bulk shipping option for plastics. 12 characters |
   INCN_EFFC_END_DT    | Incentive Effective End Date Date the incentive pricing period ended. Format: YYMMDD |
   ADDT_XREF_ONE_ID    | Additional Cross-reference Number 1 Identifier Identifier of another account associated with the principal cardholder. 16 digits |
   EXPR_DT    | Expiration Date Date the cardholder plastic expires. Format: MMYY |
   LAST_PYMT_AM    | Last Payment Amount Dollar-and-cent amount of the most recent payment posted. Format: 9999999999999999.99 |
   MISC_FOUR_ID    | Miscellaneous Field 4 Identifier Client-defined 10 characters |
   MAIL_CD    | Mail Code Code representing the shipping method for plastics and related products. See Plastics Mail Codes wiki in the Plastics Management API. 3 characters |
   LAST_NMN_TYPE_CD    | Last Non-monetary Type Code Code representing the type of the most recent non-monetary transaction posting to the account. 4 characters |
   ANNL_CASH_ADVN_RT    | Annual Cash Advance Rate. Annual interest rate charged for cash advances. Format: 99.999 |
   CTD_UNPD_BPD_AM    | Cycle-to-date Unpaid Billed Payment Due Amount. Amount billed but not paid during the current cycle. Format: 9999999999999999.99 |
   NEXT_PYMN_DUE_DT    | Next Payment Due Date. Date 25 days from the date of the last statement. Format: MM-DD-YY    |
   AccountDescription    | Description of the card program (i.e. MasterCard Classic, Visa Gold) |
   AccountType    | Type of account. * C = Credit * D = Debit |
   CommercialCardCode    | Type of Commercial Card account: * C = Control * I = Individual * S = Sub |
Customer Definitions
For the endpoint - /omaha/cardholder-account-presentation.get - the following table defines the object model regarding for the return value of Customer.
Custom Object Definitions for Customers
Property | Description |
---|---|
SOCL_SCRT_ID | Customer’s social security number (SSN) 9 characters |
MBR_SQNC_ID | System-assigned code representing a specific customer on the account. Valid Codes: * 00001 = Principal customer * 00002 = Secondary customer * 00003 – 00250 = Additional customers |
BRTH_DT | Birthdate Date of principal customer’s birth. Format: YYYY-MM-DD |
CUST_NM | Customer name Name of customer to be stored on the System. 26 characters |
MTHR_MADN_NM | Mother’s Maiden Name Customer’s mother’s maiden name. 8 characters |
CUST_ROLE_CD | Customer Role Code Code representing the role the customer plays on the account. Valid codes: * 01 = Primary * 02 = Secondary * 03 = Additional |
PI_RPLC_SQNC_NR | Presentation Instrument Replacement Sequence Number Identifier of presentation instruments within a customer account 4-digit number |
CRBR_RPRT_CD | Credit Bureau Report Code Code representing either a request for an action related to credit reporting or the consumer’s liability for the account. Valid codes: * D = Request deletion from credit bureau files * T = Terminated * X = Deceased * Z = Do not report * 1 = Individual. This code identifies a cardholder who has contractual responsibility for this account and is primarily responsible for payment. * 2 = Joint contractual liability. This code identifies a cardholder and joint borrower who are both contractually liable. * 3 = Authorized user. This code identifies a consumer who can use this account without joint responsibility for payment. * 5 = Co=maker. This code identifies cosigners without a spouse relationship. * 7 = Maker. This code identifies a cardholder who is liable for the account, but the co-maker is liable if the maker defaults. |
ADDR_CNTN_LINE_ONE_TX | Mailing address line 1 Text describing the first line of the customer’s mailing address. 26 characters max |
ADDR_CNTN_LINE_TWO_TX | Mailing address line 2 Text describing the second line of the customer’s mailing address. 26 characters max |
CITY_NM | City City of the customer’s address. 18 characters |
ADDR_SBDV_ONE_TX | Address Subdivision One Text State abbreviation or province code of cardholder’s mailing address. 2 characters |
PSTL_CD | Postal Code ZIP code or postal code of the customer’s mailing address. 10 characters max |
HOME_PHON_ID | Primary Customer Home Phone Identifier Telephone number of customer’s home. 19 characters max |
BSNS_PHON_ID | Primary Customer Second Phone Identifier Alternate telephone number where the customer can be reached. 19 characters max |
MOBL_PHON_ID | Mobile Phone Identifier Mobile telephone number of the customer This field is reserved for Universal Addressing processors. 19 characters max |
FCSM_ID | Facsimile Phone Identifier Facsimile number of the customer This field is reserved for Universal Addressing processors. 19 characters max |
PAGR_PHON_ID | Pager phone number Pager telephone number of the customer. This field is reserved for Universal Addressing processors. 19 characters max |
PLST_CT | Total number of plastics issued on account Format: 99999 |
PLST_TYPE_CD | Type of plastic to emboss Valid codes: * 0 = Do not emboss plastics for the principal cardholder on this account. * 1 = Use the parameters in the Plastic Products strategy for plastic type 1 to emboss plastics on this account. * 2 = Use the parameters in the Plastic Products strategy for plastic type 2 to emboss plastics on this account. * 3 = Use the parameters in the Plastic Products strategy for plastic type 3 to emboss plastics on this account. * 4 = Use the parameters in the Plastic Products strategy for plastic type 4 to emboss plastics on this account. * 5 = Use the parameters in the Plastic Products strategy for plastic type 5 to emboss plastics on this account. * 6 = Do not emboss plastics or create embossing records for this account. This value is for special use when you set the Embossing Services Option parameter in the Embossing Processing section (AO AC EM) of the Product Control File to N. * 7 = Do not emboss plastics or create embossing records for this account. This value is for special use when you set the Embossing Services Option parameter in the Embossing Processing section of the Product Control File to N. |
CUST_EXTR_ID | Customer External ID System-defined and assigned customer identifier. 24 characters |
DCSD_CD | Deceased Indicator Indicator designating whether the customer is deceased. Valid customer-level indicators: * N = No, the customer is not deceased. * Y = Yes, the customer is deceased. |
PIN_VRFC_ID | PIN verification identifier PIN key indicator followed by the PIN offset encoded on the plastic. The first position is the PIN key indicator. Positions 2-5 are the PIN offset. 5 digits |
SCRT_CD | Security Code Code the System automatically assigns to magnetic stripe plastics. 6 digits |
EMAL_HOME_ADDR_TX | Home email address Text containing the customer’s home e-mail address. 50 characters max |
EMAL_WORK_ADDR_TX | Work email address Text containing the customer’s work e-mail address. 50 characters max |
PRSN_EMBS_TX | Personalized embossing text (4th line) Personalized information embossed on the fourth line of the cardholder plastic 26 characters max |
PI_ID | Presentation Instrument Identifier Identifier of the customer’s presentation instrument 19 characters |
PI_STTS_CD | Presentation Instrument Status Code Code representing the presentation instrument status at the time the hot call is taken Valid codes: • A - This presentation instrument identifier is blocked from authorization approval • C - This presentation instrument identifier is no longer considered active • L - This presentation instrument identifier is reported as lost/stolen • U - Fraud has been detected on this presentation instrument identifier • blank - This presentation instrument identifier is associated with an active presentation instrument identifier |
PI_STTS_CHNG_DT | Presentation Instrument Status Change Date Date of the last status change associated with a particular presentation instrument identifier Format: YYYY/MM/DD |
PI_RPLC_DT | Presentation Instrument Plastic Replacement Date Date that the presentation instrument identifier has been replaced with a new presentation instrument identifier for the associated customer role Format: YYYY/MM/DD |
PI_EXPR_DT | Presentation Instrument Expiration Date Date the presentation instrument expires Format: YYYY/MM/DD |
PI_FRAD_STGY_ID | Presentation Instrument Fraud Strategy Identifier Client-defined code representing the fraud strategy assigned to the presentation instrument identifier. Values 01-98 are used to identify a valid fraud strategy. The default value 99 indicates a presentation instrument-level fraud strategy does not apply to the presentation instrument identifier. The PI_FRAD_STGY_EXPR_DT field identifies the expiration date of the fraud strategy assigned to the presentation instrument identifier. 2 characters |
PI_FRAD_STGY_EXPR_DT | Presentation Instrument Fraud Strategy Expiration Date Date the fraud strategy assigned to the presentation instrument expires. The default value 0001-01-01 indicates that no expiration date has been set for the fraud strategy assigned to the presentation instrument identifier. The PI_FRAD_STGY_ID field identifies the fraud strategy assigned to the presentation instrument identifier. Format: YYYY-MM-DD |
PI_ACTV_CD | Presentation Instrument Activation Code Code indicating whether the presentation instrument has been activated. Once activated, the code will change to 0 immediately. Valid codes: • 0 - No card activation status • 1 - Never block for card activation • 7 - Positive cardholder identification and/or verification of plastic receipt has not yet been established for this new plastic or plastic issued for a reason other than reissue. • 8 - Positive cardholder identification and/or verification of plastic receipt has not yet been established for this reissued plastic. Separate Entity Processing clients only |
PLST_RPLC_IN | Plastic Replacement Indicator Code indicating whether this presentation instrument identifier has been replaced with a new presentation instrument identifier for the associated customer role. Valid codes: • N - This presentation instrument identifier has not been replaced. • Y - This presentation instrument identifier has been replaced with a new presentation instrument identifier. |
PI_LAST_NMN_DT | Presentation Instrument Last Non-Monetary Date Date of the last non-monetary transaction that was initiated with a presentation instrument identifier. Format: YYYY/MM/DD |
PI_LAST_NMN_CD | Presentation Instrument Last Non-Monetary Code Code indicating the last update related to the attributes associated to a particular presentation instrument identifier. 5 characters max |
CLNT_CNTR_CUST_ID | 24 characters max |
LFTM_HIGH_BAL_AM | Lifetime High Balance Amount Amount of the highest balance an account has shown during its lifetime. 19 characters Format: 9999999999999999.99 |
LFTM_HIGH_BAL_UPDT_DT | Lifetime High Balance Update Date Processing date when the value displayed in the LFTM_HIGH_BAL_AM field posted to the cardholder account record most recently. 10 characters Format: MM/DD/YYYY |
Delinquent Amount Cycles 1-7 - | |
DLNQ_ONE_CYCL_AM | One Cycle Delinquent Amount Dollar-and-cent amount on the customer account that is one cycle delinquent. 19 characters Format: 9999999999999999.99 |
DLNQ_TWO_CYCL_AM | Two Cycle Delinquent Amount Dollar-and-cent amount on the customer account that is two cycles delinquent. 19 characters Format: 9999999999999999.99 |
DLNQ_THRE_CYCL_AM | Three Cycle Delinquent Amount Dollar-and-cent amount on the customer account that is three cycles delinquent. 19 characters Format: 9999999999999999.99 |
DLNQ_FOUR_CYCL_AM | Four Cycle Delinquent Amount Dollar-and-cent amount on the customer account that is four cycles delinquent. 19 characters Format: 9999999999999999.99 |
DLNQ_FIVE_CYCL_AM | Five Cycle Delinquent Amount Dollar-and-cent amount on the customer account that is five cycles delinquent. 19 characters Format: 9999999999999999.99 |
DLNQ_SIX_CYCL_AM | Six Cycle Delinquent Amount Dollar-and-cent amount on the customer account that is six cycles delinquent. 19 characters Format: 9999999999999999.99 |
DLNQ_SEVN_CYCL_AM | Seven Cycle Delinquent Amount Dollar-and-cent amount on the customer account that is seven cycles delinquent. 19 characters Format: 9999999999999999.99 |
CTD_NON_DLNQ_MPD_AM | Cycle-to-date Non-Delinquent Minimum Payment Due Amount Amount of the minimum payment due as defined by settings in the Minimum Payment Due (CP PO MP) section of Product Control File minus the total delinquent portion of the current statement balance. 19 characters Format: 9999999999999999.99 |
TOTL_CASH_ADVN_BAL_AM | Total Cash Advance Balance Amount Total dollar-and-cent amount of the principal amount of cash in the multiple-use FLAP (MUF) account, plus the total unpaid cash advance principal on the account after the account goes through cycle time, plus the current unpaid cycle-to-date cash advance principal on the account. 19 characters Format: 9999999999999999.99 |
MISC_THRT_ID | Miscellaneous Field 13 Identifier. Client-defined 50 characters max |
Plasitc Mail Codes
This Plastics Mail Codes Table is a reference for the parameter mail_Cd for /omaha/cardholder-account-presentation.get in the Account Information API.
Code | Description |
---|---|
000 | Send plastics to customer via United States Postal Service® (USPS®) First-Class Mail® shipment, no special handling (with inserts). |
007 | Send plastics to customer via FedEx® shipment (with inserts). |
069 | Send plastics to customer via FedEx® shipment (with inserts). |
074 | Send plastics to you via DHL shipment (with inserts). DHL is only used for international shipments. |
075 | Send plastics to customer via United States Postal Service® (USPS®) First-Class Mail® INDICIA shipment, no special handling (with inserts). |
107 | Send plastics to customer via DHL shipment (with inserts). DHL is only used for international shipments. |
111 | Send plastics to customer via DHL shipment (with inserts).DHL is only used for international shipments. |
329 | Send Braille plastics to customer via United States Postal Service® (USPS®) First-Class Mail® shipment (with inserts). This option enables you to emboss and ship Braille plastics without submitting the FDR 63-135, Omaha Braille Hand Emboss form. Before using this option, consult with CO-OP. If you use this mail code to produce Braille plastics, do not assign a rush indicator code to the embossing request. A rush indicator code will override this code and cause plastics to be produced and shipped without Braille characters. |
333 | Send plastics to customer via United States Postal Service® (USPS®) Express Mail® shipment (with inserts). |
339 | Send plastics to customer on Saturday via FedEx® shipment (with inserts). This code is available only for clients who use the Card Issuance Unit (CIU) system for plastics processing. |
340 | Send plastics to you on Saturday via FedEx® shipment (with inserts). This code is available only for clients who use the CIU system for plastics processing. |
341 | Send plastics to customer on Saturday via FedEx® shipment (with inserts). This code is available only for clients who use the CIU system for plastics processing. |
342 | Send plastics to you on Saturday via FedEx® shipment (with inserts).This code is available only for clients who use the CIU system for plastics processing. |
348 | Send plastics to you via UPS® Next Day Air® shipment (with inserts). |
371 | Send plastics to customer on Saturday via UPS® Next Day Air® |
376 | Send plastics to customer via UPS® Next Day Air® shipment |
840 | Send plastics to you via FedEx® shipment (with inserts). |
845 | Send plastics to you via FedEx® shipment (with inserts). |
850 | Send plastics to you via FedEx® shipment (without inserts). |
888 | Send plastics to customer via FedEx® shipment (with inserts). |
902 | Send plastics to customer via FedEx® shipment (with inserts). |
910 | Send plastics to you via FedEx® shipment (with inserts). |
911 | Send plastics to you via FedEx® shipment (without inserts). |
978 | Send plastics to you via United States Postal Service® (USPS®) Registered Mail® shipment (with inserts). |
979 | Send plastics to you via United States Postal Service® (USPS®) Registered Mail® shipment (without inserts). |
980 | Send plastics to customer via United States Postal Service® (USPS®) Certified Mail® shipment (with inserts). |
982 | Send plastics to customer via United States Postal Service® (USPS®) First-Class Mail® shipment and produce post mailers. This option produces post mailers on an individual basis when the Post parameter in the Unit Contents section (CI PR UC) of the Product Control File is not used to generate them. |
999 | Send plastics to customer via United States Postal Service® (USPS®) Registered Mail® shipment (with inserts). |